Manage Promo Codes

This use case describes a kind of promo code lifecycle. The focus is on how to create, search for, cancel and troubleshoot promo codes, which customers can redeem to acquire point-based rewards. Promo codes can be configured to enable customer service teams to reward customers for activities such as positive feedback and social media sharing. These codes can even be printed and handed out at live events, and they can be used within a broader marketing campaign.

The APIs detailed in this section provide programmatic access to promo codes, so they can be created and subsequently located via searches. Once retrieved, customer service teams can cancel or trouble shoot specific codes that require some level of intervention.

Note that promo codes are not a replacement for anonymous offers. Each code must be claimed against real, registered customers. Doing so is an excellent mechanism for providing a sound loyalty experience to a known customer.

Developer or Administrator Journey

One helpful way of understanding this use case is to consider how it reflects the developer's or administrator's (admin) experience and responsibilities in their work maintaining promo codes as part of a client's loyalty program.

Developer or admin accesses development environment

Developer or admin creates batch of single-use promo codes

Developer or admin searches for specific promo code

Developer or admin cancels promo code

Developer or admin troubleshoots promo code issues

Platform Configuration

Before implementing this use case, ensure the following have been configured:

Promo Codes

Promo Codes Module is enabled on platform. For more information, contact your SessionM team.

Points

Point accounts, and corresponding point sources, if outcome is points.

Offers

Offers configured in Offer Management module or via API if outcome is and offer.

Sequence Diagram

See the overall flow for this use case below.

DEVELOPER/ADMIN DEVELOPER/ADMIN CLIENT MIDDLEWARE CLIENT MIDDLEWARE SESSIONM SESSIONM CREATE BATCH OF PROMO CODES 1 Access platform development environment 2 Create new batch of single-use promo codes 3 Return response that includes generation request ID 4 Display response SEARCH FOR PROMO CODE 5 Determine promo code must be Option 1: Get Promo Code for Known Customer 6 Get claimed promo code based on customer ID Option 2: Get Details on Known Promo Code 7 Get details on claimed or unclaimed promo code 8 Return promo code details 9 Display promo code details CANCEL PROMO CODE 10 Decide to cancel promo code 11 Cancel promo code 12 Return success message for cancelled code 13 Display message TROUBLESHOOT PROMO CODE ISSUES 14 Determine cause of promo code issue Option 1: Get All Promo Codes 15 Retrieve all promo codes for promo code list Option 2: Get Status of Promo Code Generation 16 Retrieve status for promo code generation request Option 3: Get Invalid Promo Codes 17 Retrieve invalid promo codes claimed by customer 18 Return desired promo codes or related data 19 Display desired promo codes or related data

Tasks

This use case diagram contains multiple tasks, each one depicted in its own color-coded section. For more information, see the overview below.

  1. Create Batch of Single Use Promo Codes (Use Case Events #1 - #4)

    Build new batch of single-use promo codes.

  2. Search for Promo Code (Use Case Events #5 - #9)

    Two ways to search for promo code.

  3. Cancel Promo Code (Use Case Events #10 - #13)

    How to cancel a promo code.

  4. Troubleshoot Promo Code Issue (Use Case Events #14 - #19)

    Steps that help troubleshoot promo code issues.

Take Note

By default, requests are capped at 1 million codes. Contact your SessionM representative if you need to raise the cap.